DESCRIPTION

    DoomArena is a waiting room for DOOM games.  People everywhere on the
    net can run doomarena and then start doom games with other people
    waiting to play.  It is a great tool to help you waste more time
    playing doom.  This is good, because playing doom is very therapeutic
    and will make the time you do spend working much more productive.

    DoomArena makes it really easy to start networked DOOM games with
    other people.  Here are some of the advantages DoomArena has over
    regular Sun DOOM:

        o  Easy startup of networked games
        o  Full Mouse support (not part of standard Sun DOOM)
        o  Easy and reliable configuration of game options
        o  Frag matrix with realtime updates
           (e.g., who has killed who, and how many times)
        o  .doomrc configuration panel
        o  Audio controls


INSTALLATION

    DoomArena should be installed in a directory that is accessible
    from NFS.  Use the "share" command to figure out which disk
    partitions are exported.

    Installation steps:

    0) Optional:  Create a "doom" user on your machine, and install
       doomarena as the "doom" user.  Then you can run the server
       as the "doom" user, rather than yourself.

    1)  uncompress DoomArena-1.0.tar.Z
    2)  tar xf DoomArena-1.0.tar
    
    This will create a directory called "doomarena".
    
    3)  This step is necessary to enable network play:
    
        Edit the file doomarena/src/script/Makefile.
        Remove the following line:
    
    DAPARENT:sh = cd ../.. ; pwd
    
        Set DAPARENT to the auto-mountable path where doomarena
        is installed.  For example:
    
    DAPARENT=/net/hostname.domain/export/games/doomarena
    
        People on other machines will then be able to invoke
        /net/hostname.domain/export/games/doomarena/bin/doomarena,
        and will connect to your DoomArena server.  I couldn't figure
        out how to automatically determine the auto-mountable path
        for a given directory, therefore this step is needed.  If
        you know how to do this automatically, I would appreciate
        your feedback.
    
    4)  cd doomarena ; ./arenacache
    
    
    + To run the server +
    
    cd doomarena/server
    ./das >& das.out &

    Note: The server must be run on the same machine where the
          "arenacache" command was run.
    
    + To run the client +
    
    cd dooarena/bin
    ./doomarena

    Note: The client can be run from any machine that has NFS access
          to the doomarena installation.
    
    A copy of DoomArena will be installed in /tmp, or a local directory of
    your choice.  The reason for this is that people running doomarena
    over the net will get MUCH better performance with DoomArena installed
    on their local disk.

    + Running doomarena locally +

    If you are on the same machine as the doomarena installation, you
    can run doomarena with the -local flag.  This means that doomarena
    will not be installed in /tmp, but will be run directly from the
    original install directory.  This is a useful option if you
    simply want to play single player DOOM and don't care about
    networked play.


REGISTERED WAD FILES

    DoomArena comes with doom1.wad.  This is the shareware version
    of the DOOM.  If you purchase a copy of DOOM or DOOM II, then
    you can play the registered version of the wad file with Sun DOOM.

    DoomArena comes with some shareware wads written by various
    people that are enabled only if the registered wad for DOOM
    or DOOM II is installed.

    To upgrade DoomArena with the registered wad files, you must
    buy DOOM or DOOM II and then patch the wad file to version 1.8
    or 1.9.  This requires a PC machine because the patch scripts
    will only run under DOS.

    1)  Install DOOM and/or DOOM II on a DOS machine

    2)  Copy and apply the appropriate patch file(s).  The patch files
        are available via anonymous ftp at the locations listed below.
        You need to apply a combination of patches that will get you
        from your current DOOM version up to version 1.8 or 1.9.
        1.8 is preferable, but 1.9 will do.  The DOOM demo causes the
        game to crash if you have any version other than 1.8, therefore
        with version 1.9 you have to start a game quickly before the demo
        starts running.  Your current DOOM version is the one listed
        at the top of the screen when you start DOOM on the PC.

        Patches for DOOM and DOOM II can be found at the following sites.
        (The "idstuff" directory contains the patches.)
    
        California  ftp.cdrom.com/pub/doom
        Texas       ftp.idsoftware.com/tonsmore/doom/
        Utah        ftp.pht.com/pub/games/doom/
        Wisconsin   ftp.uwp.edu/pub/games/id/home-brew/doom/
        New York    doomgate.cs.buffalo.edu/pub/idgames/
        S. Africa   ftp.sun.ac.za/pub/msdos/idgames/
        Taiwan      nctuccca.edu.tw/PC/games/DOOM/
        Austria     flinux.tu-graz.ac.at/pub/idsoftware/
        Germany     ftp.fu-berlin.de/pc/msdos/games/doom
        Netherlands ftp.sls.wau.nl/pub/msdos/doom/
        England     ftp.dungeon.com/pub/msdos/games/IDgames/
        Sweden      ftp.luth.se/pub/games/doom/
        France      anasgard.calvacom.fr/pub/pc/doom

    3)  Copy doom.wad and/or doom2.wad from the PC into the top level
        doomarena directory.  This is best done using pkzip because it
        will split the wad file across multiple floppies.  pkzip,
        pkunzip, and unzip are included as part of doomarena, and can
        be found in the zip directory.

        Invoke the pkzip command as follows:
            pkzip -& a:\doom.zip doom.wad

        To unzip the wad on the Sun machine, copy all the zip files off
        of the floppies, cat them all together, and use unzip.  Be sure
        to use the version of unzip from doomarena/zip/unzip!  "unzip" will
        spew a bunch of warnings, but these can be ignored.
            cat doom.zip1 doom.zip2 doom.zip3 ... > doom.zip
            unzip doom.zip

        This operation can be done with only one floppy as follows:
        PC
            pkzip -& a:\doom.zip doom.wad
            Insert disk #2 - Press a key when ready
            <Take the disk out and put it in the Sun machine>
        SUN
            volcheck
            cp /floppy/<diskname>/doom.zip ./doom.zip1
            rm /floppy/<diskname>/doom.zip
            eject
            <Put the floppy back in the PC and press a key>

        Repeat these steps to create doom.zip1, doom.zip2, etc., then
        invoke unzip as follows:
            cat doom.zip1 doom.zip2 doom.zip3 ... > doom.zip
            unzip doom.zip

        Move the doom.wad and/or doom2.wad file into the top level
        doomarena directory.  Be sure to rename DOOM.WAD to doom.wad,
        and DOOM2.WAD to doom2.wad.

    4)  Re-run the DoomArena clients:
            doomarena/server/dasadmin RerunClients
        NOTE:  Re-running the DoomArena clients will kill all currently
               running DOOM games.  This tends to upset people, so be
               careful.


ADMINISTRATION

    Read the file doc/administration for directions on adding new sounds
    and new wad files.


PERFORMANCE

    The version of sundgadoom included with DoomArena has been
    tuned for the sun4m architecture.  Therefore, you will not
    get very good performance on sun4c machines (SS1, SS2, etc.).


AUTHORS
    Douglas Stein
    Steve Jankowski


BUGS/COMMENTS
    Send email to doomarena-bugs@bds.eng.sun.com